API 文档简介
API 文档简介
前言
认证
错误
分页
参数说明
元数据
基础交易
Charges 支付
Charges 支付概述
创建 Charge 对象
撤销 Charge 对象
查询 Charge 对象
查询 Charge 对象列表
Charge 相关的 Event 类型
Refunds 退款
Refunds 退款概述
创建 Refund 对象
查询 Refund 对象
查询 Refund 对象列表
Refund 相关的 Event 类型
Batch Refunds 批量退款
Batch Refunds 批量退款概述
创建 Batch Refund 对象
查询 Batch Refund 对象
查询 Batch Refund 对象列表
Batch Refund 相关的 Event 类型
Transfers 企业付款
Transfers 企业付款概述
创建 Transfer 对象
查询 Transfer 对象
查询 Transfer 对象列表
Transfer 相关的 Event 类型
Batch Transfers 批量企业付款
Batch Transfers 批量企业付款概述
创建 Batch Transfer 对象
查询 Batch Transfer 对象
查询 Batch Transfer 对象列表
Batch Transfers 相关的 Event 类型
Red Envelopes 红包
Red Envelopes 红包概述
创建 Red Envelope 对象
查询 Red Envelope 对象
查询 Red Envelope 对象列表
Red envelope 相关的 Event 类型
会员账户系统
用户
Users 用户
Users 用户概述
创建 User 对象
查询 User 对象
更新 User 对象
查询 User 对象列表
Settle Accounts 用户结算账户
Settle Accounts 用户结算账户概述
创建 Settle Account 对象
查询 Settle Account 对象
删除 Settle Account 对象
查询 Settle Account 对象列表
订单
Orders 订单
Orders 订单概述
创建 Order 对象
支付 Order 对象
取消 & 更新 Order 对象
查询 Order 对象
查询 Order 对象列表
查询 Order 中的 Charge 对象
查询 Order 中的 Charge 对象列表
Order 对象相关的事件类型
订单 Refunds 退款
订单 Refunds 退款概述
创建订单 Refund 对象
查询订单 Refund 对象
查询订单 Refund 对象列表
Refund 对象相关的事件类型
余额
Recharges 充值
Recharges 充值概述
创建 Recharge 对象
查询 Recharge 对象
查询 Recharge 对象列表
Recharge 相关的 Event 类型
充值 Refunds 退款
充值 Refunds 退款概述
创建充值 Refund 对象
查询充值 Refund 对象
查询充值 Refund 对象列表
充值 Refund 相关的 Event 类型
Withdrawals 提现
Withdrawals 提现概述
创建 Withdrawal 对象
更新 Withdrawal 对象
查询 Withdrawal 对象
查询 Withdrawal 对象列表
Withdrawal 相关的 Event 类型
Batch Withdrawals 批量提现
Batch Withdrawals 批量提现概述
创建 Batch Withdrawal 对象
查询 Batch Withdrawal 对象
查询 Batch Withdrawal 对象列表
Batch Withdrawal 对象相关的 Event 类型
Balance Bonuses 余额赠送
Balance Bonuses 余额赠送概述
创建 Balance Bonus 对象
查询 Balance Bonus 对象
查询 Balance Bonus 对象列表
Balance Transfers 余额转账
Balance Transfers 余额转账概述
创建 Balance Transfer 对象
查询 Balance Transfer 对象
查询 Balance Transfer 对象列表
Balance Settlements 余额结算
Balance Settlements 余额结算概述
查询 Balance Settlement 对象
查询 Balance Settlement 对象列表
Balance Transactions 余额明细
Balance Transactions 余额明细概述
查询 Balance Transaction 对象
查询 Balance Transaction 对象列表
优惠券
Coupon Templates 优惠券模板
Coupon Templates 优惠券模板概述
创建 Coupon Template 对象
查询 Coupon Template 对象
查询 Coupon Template 对象列表
更新 Coupon Template 对象
删除 Coupon Template 对象
Coupons 优惠券
Coupons 优惠券概述
创建 Coupon 对象
批量创建 Coupon 对象
查询 Coupon 对象
查询用户的 Coupon 对象列表
查询 Coupon 对象列表
更新 Coupon 对象
删除 Coupon 对象
多级商户系统
用户
Users 用户
Users 用户概述
创建 User 对象
查询 User 对象
更新 User 对象
查询 User 对象列表
Settle Accounts 用户结算账户
Settle Accounts 用户结算账户概述
创建 Settle Account 对象
查询 Settle Account 对象
删除 Settle Account 对象
查询 Settle Account 对象列表
商户层级
Sub Apps 子商户应用
Sub Apps 子商户应用概述
创建 Sub App 对象
查询 Sub App 对象
更新 Sub App 对象
删除 Sub App 对象
查询 Sub App 对象列表
Channels 子商户渠道参数
Channels 子商户渠道参数概述
创建子商户 Channel 对象
查询子商户 Channel 对象
更新子商户 Channel 对象
删除子商户 Channel 对象
订单
Orders 订单
Orders 订单概述
创建 Order 对象
支付 Order 对象
取消 & 更新 Order 对象
查询 Order 对象
查询 Order 对象列表
查询 Order 中的 Charge 对象
查询 Order 中的 Charge 对象列表
Order 对象相关的事件类型
订单 Refunds 退款
订单 Refunds 退款概述
创建订单 Refund 对象
查询订单 Refund 对象
查询订单 Refund 对象列表
Refund 对象相关的事件类型
分润
Royalties 分润
Royalties 分润概述
批量更新 Royalty 对象
查询 Royalty 对象
查询 Royalty 对象列表
Royalty Templates 分润模板
Royalty Templates 分润模板概述
创建 Royalty Template 对象
查询 Royalty Template 对象
查询 Royalty Template 对象列表
更新 Royalty Template 对象
删除 Royalty Template 对象
Royalty Settlements 分润结算
Royalty Settlements 分润结算概述
创建 Royalty Settlement 对象
查询 Royalty Settlement 对象
更新 Royalty Settlement 对象
查询 Royalty Settlement 对象列表
Royalty Transactions 分润结算明细
Royalty Transactions 分润结算明细概述
查询 Royalty Transaction 对象
查询 Royalty Transaction 对象列表
Royalty Transaction 相关的 Event 类型
辅助接口
身份证银行卡信息认证接口
身份证银行卡信息认证接口概述
请求认证接口
Webhooks 回调
Webhooks 回调概述
Event 事件类型
查询 Event 对象
附录
支付渠道属性值
支付渠道 extra 参数说明
子商户应用渠道参数说明
微信企业付款银行编号列表
通联代付银行编号说明
通联代付业务代码说明
京东代付银行编号说明
银联电子代付银行编号说明
易宝支付商品类型码
易宝支付用户标识类型码
认证接口 result_code 说明
跨境渠道 currency 说明
API 更新日志
API 更新日志
Order 对象相关的事件类型
该类型的 Event 对象会在
order
对象订单付款完成后触发,以 Webhooks 形式发送至客户配置的 Webhooks URL 。详情请参考
Events 事件
。
事件类型
描述
order.succeeded
商品订单 Order 对象,Order 支付成功时触发。
charge.succeeded
支付订单 Charge 对象,Order 支付成功时触发。
cURL
PHP
Java
Ruby
Node.js
Python
Go
C#
API